Skip to content

[doc-only] Verify rendered release notes before upload - #3528

Open
rwgk wants to merge 3 commits into
mainfrom
rwgk/verify-rendered-release-notes
Open

rwgk wants to merge 3 commits into
mainfrom
rwgk/verify-rendered-release-notes

Conversation

@rwgk

@rwgk rwgk commented Nov 21, 2026

Copy link
Copy Markdown
Contributor

— codex GPT-6 on behalf of Ralf —

Description

Check release documentation after the build stages its files and before any upload. For the tagged component, require the versioned notes HTML and a link to it from the rendered release index. Reuse the tag policy for both bindings majors, the metapackage, Core, and Pathfinder, with the existing internal-tag, post-release, and placeholder exceptions.

The regression tests fail when a required page is absent or the index points to the wrong path. The checker also passed against published HTML for both bindings majors, the metapackage, Core, and Pathfinder.

Checklist

  • I have read the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@copy-pr-bot

copy-pr-bot Bot commented Nov 21, 2026

Copy link
Copy Markdown
Contributor

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@rwgk rwgk added CI/CD CI/CD infrastructure documentation Improvements or additions to documentation labels Nov 21, 2026
@rwgk rwgk self-assigned this Nov 21, 2026
@rwgk rwgk added this to the CI milestone Nov 21, 2026
@rwgk

rwgk commented Nov 21, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test f50b054

@github-actions

Copy link
Copy Markdown
Contributor

@rwgk

rwgk commented Nov 21, 2026

Copy link
Copy Markdown
Contributor Author

— codex GPT-6 on behalf of Ralf —

Docs CI and all 436 local CI-tool tests passed at PR head f50b054. The focused regression cases fail for a missing note and a wrong index link. I also downloaded the real 12.9.11 bindings artifact and confirmed both faults are rejected independently, then confirmed the intact artifact passes.

The hosted release rehearsals used the existing tags and a blank Pages deployment branch input.

  • CUDA 12.9.11 bindings, CUDA 12.9.11 metapackage, and Pathfinder 1.9.1 passed the new gate on the staged versioned page and index.
  • CUDA 13.5.1a0 passed the CUDA 13 route and exercised the internal-tag exemption.
  • I also ran the checker on published CUDA 13.5.0 and Core 1.3.1 HTML with their tagged note sources. These tags use the older release layout, so replaying their published HTML covered the required-note path with real output.

@rwgk
rwgk marked this pull request as ready for review November 21, 2026 06:23
@coderabbitai

coderabbitai Bot commented Nov 21, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Chores
    • Release builds now check that applicable release notes are present in the rendered documentation and linked from the versioned release index.
    • Validation accounts for component-specific release tags and skips internal tags and empty Pathfinder placeholders.
  • Tests
    • Added coverage for rendered release-note pages, versioned links, and cases where notes are not required.

The release documentation workflow now checks rendered release notes after building documentation. The checker validates applicable versioned note pages and index links, with exceptions for internal tags and empty Pathfinder placeholders.

Changes: Rendered Release Notes Validation

Layer / File(s) Summary
Checker selection and rendered validation
ci/tools/check_tagged_release_notes.py, ci/tools/tests/test_check_rendered_release_notes.py
The checker accepts --rendered-docs and component all. It validates rendered note pages and their relative links from the release index. Tests cover valid and invalid paths, tag-based component selection, and the documented skip cases.
Release workflow integration
.github/workflows/build-docs.yml
When inputs.is-release is true, the workflow runs the checker against the rendered documentation with the release tag and component.

Suggested reviewers: cpcloud, jpascucci-nv

Change: Other

Merge Risk: Minimal · up to f50b0

This change adds a release-time check that rendered release notes exist and are linked from the versioned release index. It affects only release documentation builds. No actionable merge-blocking risk remains.

Security architecture risk: Minimal · up to f50b0

The new check reads staged documentation and blocks publication when required release notes or links are missing. The inspected change does not expand deployment privileges or weaken existing publication controls. No introduced or worsened architecture-level security risk was established.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The new checker can allow or block the current documentation build's publication path based on release inputs and staged files. Its inspected implementation adds no package-publication, runtime-service, credential, or data-store operation.

Trust Boundaries and Controls

  • observed — Workflow tag, component, and bindings JSON inputs reach the checker through quoted arguments rather than shell-source interpolation. Existing parsing constrains component choices, rejects malformed or mismatched release identity, and validates resolved bindings paths as normalized repository-relative paths. The HTML check is a structural publication check, not a content-authenticity or sanitization control.

Resilience and Maintainability Implications

  • observed — The workflow retains run-attempt-specific deployment payload names, a successful-build prerequisite, and serialized publication without cancelling an active publisher. Its existing recovery guidance requires rerunning all jobs when deployment prerequisites must be recreated; the new validator adds no persistent state to that recovery process.
- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between edf1b31 and f50b054.

Files selected for processing: 3

  • .github/workflows/build-docs.yml
  • ci/tools/check_tagged_release_notes.py
  • ci/tools/tests/test_check_rendered_release_notes.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 9 remain after this review.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant